Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

[AAP-34936] Manage Django Settings with Dynaconf #15702

Open
wants to merge 11 commits into
base: devel
Choose a base branch
from
Open

[AAP-34936] Manage Django Settings with Dynaconf #15702

wants to merge 11 commits into from

Conversation

rochacbruno
Copy link
Member

@rochacbruno rochacbruno commented Dec 11, 2024 •
edited
Loading

AAP-34936

New or Enhanced Feature

Settings now managed by Dynaconf.

export DJANGO_SETTINGS_MODULE=awx.settings
dynaconf list
dynaconf inspect

NOTE: Currently depends on DAB ansible/django-ansible-base#689 to be merged.

DOCS https://github.com/rochacbruno/django-ansible-base/blob/dynaconf_settings/docs/lib/dynamic_config.md

@github-actions github-actions bot added component:api dependencies Pull requests that update a dependency file labels Dec 11, 2024
@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
9 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@AlanCoding
Copy link
Member

So how would the awx/conf (dynamic database backed settings) be handled with this?

@rochacbruno rochacbruno force-pushed the dynaconf branch 3 times, most recently from 2211f8f to 7cdfe26 Compare January 30, 2025 12:14
@AlanCoding AlanCoding mentioned this pull request Feb 3, 2025
Merged
@codecov Codecov
Copy link

codecov bot commented Feb 10, 2025 •
edited
Loading

Codecov Report

Attention: Patch coverage is 67.92453% with 34 lines in your changes missing coverage. Please review.

Project coverage is 75.26%. Comparing base (70ea0a7) to head (1efb08d).

✅ All tests successful. No failed tests found.

@rochacbruno rochacbruno changed the title P.O.C: Manage Django Settings with Dynaconf [AAP-34936] Manage Django Settings with Dynaconf Feb 10, 2025
@rochacbruno rochacbruno marked this pull request as ready for review February 10, 2025 19:47
@rochacbruno
Copy link
Member Author

So how would the awx/conf (dynamic database backed settings) be handled with this?

@AlanCoding will not, this is going to be on phase 2 only.

@rochacbruno rochacbruno force-pushed the dynaconf branch 2 times, most recently from 0981fdf to 4a6f6e8 Compare February 17, 2025 11:22
@rooftopcellist
Copy link
Member

FYI, it looks like the awx-operator CI check failed. The AWX deployment by the operator itself was successful, but the job template failed. This may be related to the settings changes in this PR. I would next check that job templates run successfully in the AWX dev environment. If they do, then there are likely awx-operator changes needed around how we mount-in the settings.py file into the task and web pods.

@rochacbruno rochacbruno force-pushed the dynaconf branch 2 times, most recently from d482a87 to 0eb7b4e Compare February 20, 2025 19:41
@AlanCoding
Copy link
Member

I did an updated run and got the following traceback when awx-manage version is ran.

Traceback (most recent call last):
  File "/var/lib/awx/venv/awx/lib64/python3.11/site-packages/dynaconf/loaders/py_loader.py", line 121, in get_module
    mod = importlib.import_module(filename)
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib64/python3.11/importlib/__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<frozen importlib._bootstrap>", line 1204, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1176, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1126, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "<frozen importlib._bootstrap>", line 1204, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1176, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1126, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "<frozen importlib._bootstrap>", line 1204, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1176, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1140, in _find_and_load_unlocked
ModuleNotFoundError: No module named '/etc/tower/conf'

During handling of the above exception, another exception occurred:

Traceback (most recent call last):
  File "/bin/awx-manage", line 8, in <module>
    sys.exit(manage())
             ^^^^^^^^
  File "/var/lib/awx/venv/awx/lib64/python3.11/site-packages/awx/__init__.py", line 77, in manage
    prepare_env()
  File "/var/lib/awx/venv/awx/lib64/python3.11/site-packages/awx/__init__.py", line 71, in prepare_env
    if not settings.DEBUG:  # pragma: no cover
           ^^^^^^^^^^^^^^
  File "/var/lib/awx/venv/awx/lib64/python3.11/site-packages/django/conf/__init__.py", line 102, in __getattr__
    self._setup(name)
  File "/var/lib/awx/venv/awx/lib64/python3.11/site-packages/django/conf/__init__.py", line 89, in _setup
    self._wrapped = Settings(settings_module)
                    ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/var/lib/awx/venv/awx/lib64/python3.11/site-packages/django/conf/__init__.py", line 217, in __init__
    mod = importlib.import_module(self.SETTINGS_MODULE)
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib64/python3.11/importlib/__init__.py", line 126, in import_module
    return _bootstrap._gcd_import(name[level:], package, level)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "<frozen importlib._bootstrap>", line 1204, in _gcd_import
  File "<frozen importlib._bootstrap>", line 1176, in _find_and_load
  File "<frozen importlib._bootstrap>", line 1147, in _find_and_load_unlocked
  File "<frozen importlib._bootstrap>", line 690, in _load_unlocked
  File "<frozen importlib._bootstrap_external>", line 940, in exec_module
  File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
  File "/var/lib/awx/venv/awx/lib64/python3.11/site-packages/awx/settings/__init__.py", line 50, in <module>
    DYNACONF.load_file(settings_files_path)
  File "/var/lib/awx/venv/awx/lib64/python3.11/site-packages/dynaconf/base.py", line 1305, in load_file
    settings_loader(
  File "/var/lib/awx/venv/awx/lib64/python3.11/site-packages/dynaconf/loaders/__init__.py", line 352, in settings_loader
    py_loader.load(
  File "/var/lib/awx/venv/awx/lib64/python3.11/site-packages/dynaconf/loaders/py_loader.py", line 35, in load
    mod, loaded_from = get_module(obj, settings_module, silent)
                       ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/var/lib/awx/venv/awx/lib64/python3.11/site-packages/dynaconf/loaders/py_loader.py", line 125, in get_module
    mod = import_from_filename(obj, filename, silent=silent)
          ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/var/lib/awx/venv/awx/lib64/python3.11/site-packages/dynaconf/loaders/py_loader.py", line 161, in import_from_filename
    exec(compile(config_file.read(), filename, "exec"), mod.__dict__)
  File "/etc/tower/conf.d/gateway.py", line 9, in <module>
    LOGGING['loggers']['aap'] = {'handlers': ['console', 'file', 'tower_warnings', 'external_logger'], 'level': 'WARNING'}
    ^^^^^^^
NameError: name 'LOGGING' is not defined

@sonarqubecloud SonarQubeCloud
Copy link

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@AlanCoding AlanCoding Awaiting requested review from AlanCoding

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
component:api dependencies Pull requests that update a dependency file
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@rochacbruno @AlanCoding @rooftopcellist